home *** CD-ROM | disk | FTP | other *** search
/ PC Media 4 / PC MEDIA CD04.iso / share / prog / rzsz0717 / rz.doc < prev    next >
Encoding:
Text File  |  1994-07-16  |  17.2 KB  |  463 lines

  1.  
  2.  
  3.  
  4.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       rx, rc, rb, rz - Receive Files and Commands with X/Y/ZMODEM
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       rrrrzzzz [-    ttttvvvv]
  13.       rrrrbbbb [-    ttttvvvv]
  14.       rrrrcccc [-    ttttvvvv] _f_i_l_e
  15.       rrrrxxxx [-    ttttvvvv] _f_i_l_e
  16.       ggggzzzz _f_i_l_e ...
  17.       [----][vvvv]rrrrzzzzCCCCOOOOMMMMMMMMAAAANNNNDDDD
  18.  
  19.      LLLLIIIICCCCEEEENNNNSSSSEEEE AAAAGGGGRRRREEEEEEEEMMMMEEEENNNNTTTT
  20.       This is a Copyrighted    shareware program.  Commercial use of
  21.       this program is subject to licensing conditions detailed in
  22.       the rz.c source code.     "Commercial Use" includes any use of
  23.       this program to receive files    from a commercial or shareware
  24.       program not published    by Omen    Technology INC.
  25.  
  26.       Registration information is provided in the file mailer.rz.
  27.  
  28.       Use of this program constitutes agreement to the License
  29.       Agreement.
  30.  
  31.      SSSSUUUUPPPPPPPPOOOORRRRTTTT
  32.       Unregistered users may dial 900-737-7836 (900-737-RTFM) for
  33.       technical assistance.     There is a charge of $4.69 per    minute
  34.       to use this support line.  Callers must be 18    years or
  35.       older.
  36.  
  37.       Registered users encountering    problems using this program on
  38.       standard serial ports    to transfer files with Professional-
  39.       YAM or ZCOMM may call    the support number listed in the
  40.       Professional-YAM/ZCOMM documentation.     Solutions to nearly
  41.       all file transfer problems are described in the
  42.       Professional-YAM/ZCOMM documentation.
  43.  
  44.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  45.       This program uses error correcting protocols to receive
  46.       files    over a dial-in serial port from    a variety of programs
  47.       running under    PC-DOS,    CP/M, Unix, and    other operating
  48.       systems.  It is invoked from a shell prompt manually,    or
  49.       automatically    as a result of an "sz file ..."    command    given
  50.       to the calling program.
  51.  
  52.       To obtain the    maximum    performance and    full functionality of
  53.       this program we recommend its    use with GSZ, Professional-YAM
  54.       or ZCOMM.
  55.  
  56.       This program is intended to interface    with terminal
  57.       programs, not    to act as one.    This program is    not designed
  58.       to be    called from _c_u(_1), _t_i_p(_1), or other communications
  59.       programs.  Unix flavors of Omen Technology's Professional-
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 7/17/94)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  71.  
  72.  
  73.  
  74.       YAM communications software are suitable for dial-out
  75.       applications.     Unix Professional-YAM supports    dial-out
  76.       applications with telephone directory, a powerful script
  77.       language with    learn function,    high quality multiple protocol
  78.       support, and UUCP port arbitration.
  79.  
  80.  
  81.       RRRRzzzz (Receive ZMODEM) receives one or more files with the
  82.       ZMODEM protocol.  Pathnames are supplied by the sending
  83.       program, and directories are made if necessary (and
  84.       possible).  Normally,    the "rz" command is automatically
  85.       issued by the    calling    ZMODEM program,    but defective ZMODEM
  86.       implementations may require starting _r_z manually.
  87.  
  88.       RRRRbbbb receives file(s) with YMODEM, accepting either standard
  89.       128 byte sectors or 1024 byte    sectors    (Pro-YAM/ZCOMM sb ----kkkk
  90.       option).  The    user should determine when the 1024 byte block
  91.       length actually improves throughput.
  92.  
  93.       If True YMODEM (Omen Technology trademark) file information
  94.       (file    length,    etc.) is received, the file length controls
  95.       the number of    bytes written to the output dataset, and the
  96.       modify time and file mode (iff non zero) are set
  97.       accordingly.
  98.  
  99.       If True YMODEM file information is not received, slashes in
  100.       the pathname are changed to underscore, and any trailing
  101.       period in the    pathname is eliminated.     This conversion is
  102.       useful for files received from CP/M and other    historical
  103.       systems.
  104.  
  105.       RRRRcccc receives a    single _f_i_l_e with XMODEM-CRC or XMODEM-1k-CRC
  106.       protocol.  The user should determine when the    1024 byte
  107.       block    length actually    improves throughput without causing
  108.       problems.  The user must supply the file name    to both
  109.       sending and receiving    programs.  Up to 1023 garbage
  110.       characters may be added to the received file.
  111.  
  112.       RRRRxxxx receives a    single _f_i_l_e with XMODEM    or XMODEM-1k protocol.
  113.       The user should determine when the 1024 byte block length
  114.       actually improves throughput without causing problems.  The
  115.       user must supply the file name to both sending and receiving
  116.       programs.  Up    to 1023    garbage    characters may be added    to the
  117.       received file.
  118.  
  119.       GGGGzzzz is    a shell    script which calls _s_z to command Pro-YAM or
  120.       ZCOMM    to transmit the    specified files.  Pathnames used with
  121.       _g_z must be escaped if    they have special significance to the
  122.       Unix shell.
  123.       EXAMPLE: gz "-a C:*.c    D:*.h"
  124.  
  125.       If invoked with a leading ``v'', _r_z will report progress to
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 7/17/94)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  137.  
  138.  
  139.  
  140.       /tmp/rzlog.
  141.       EXAMPLE: ln rz vrz; rz=vrz; export rz
  142.  
  143.       If the SHELL environment variable includes _r_s_h or _r_k_s_h
  144.       (restricted shell), _r_z will not accept absolute pathnames or
  145.       references to    a parent directory, will not modify an
  146.       existing file, and removes any files received    in error.
  147.  
  148.  
  149.       The meanings of the available    options    are:
  150.  
  151.       ttttttttiiiimmmm Change timeout to _t_i_m tenths of seconds.
  152.       vvvv    Verbose causes a    list of    file names to be appended to
  153.            /tmp/rzlog .  More v's generate more detailed debugging
  154.            output.
  155.       (Pro-YAM command)
  156.       <_A_L_T-_2>
  157.       Pro-YAM Command: _s_z *._h *._c
  158.       This automatically invokes _r_z    on the connected system, and
  159.       sends    all .h and .c files in the current directory.
  160.  
  161.       _s_z -_n    -_R_f .
  162.       This Professional-YAM    command    recursively follows the
  163.       current directory tree (.) (Pro-YAM -R option), sends    the
  164.       full relative    pathname (-f), for files that are newer    (-n)
  165.       than their copies on the destination system.
  166.  
  167.  
  168.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  169.       Exit status is as follows: 0 for successful transfers.  1 if
  170.       unrecoverable    errors are detected.  2    if syntax errors or
  171.       file access problems are detected.  3    if the program was
  172.       terminated by    a caught interrupt.
  173.  
  174.  
  175.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  176.       Professional-YAM, ZCOMM, DSZ,    crc(omen), sz(omen),
  177.       usq(omen), undos(omen)
  178.  
  179.       Compile time options required    for various operating systems
  180.       are described    in the source file.
  181.  
  182.      SSSSEEEERRRRVVVVEEEERRRR////NNNNEEEETTTTWWWWOOOORRRRKKKK NNNNOOOOTTTTEEEESSSS
  183.       Terminals on some timesharing    systems    are connected
  184.       indirectly to    the host with TTTTEEEERRRRMMMMIIIINNNNAAAALLLL SSSSEEEERRRRVVVVEEEERRRRSSSS operating over
  185.       networks.  Terminal servers often interfere with file
  186.       transfers by "eating"    control    characters and/or losing data.
  187.  
  188.       Accessing a distant system using tttteeeellllnnnneeeetttt or rrrrllllooooggggiiiinnnn on a local
  189.       Unix system entails the same problems.  If you have a    choice
  190.       between tttteeeellllnnnneeeetttt and rrrrllllooooggggiiiinnnn try    rlogin with the    ----8888 option.
  191.       Set the escape character to ^P (control P) which is
  192.  
  193.  
  194.  
  195.      Page 3                         (printed 7/17/94)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  203.  
  204.  
  205.  
  206.       protected by ZMODEM.
  207.  
  208.       When terminal    servers    interfere with file transfers, server
  209.       commands are often available to help the problem.  When
  210.       possible, enable the server and modems for hardware flow
  211.       control in and out.  Set the terminal    server to telnet
  212.       transparent mode.  Some typical commands are "SET TERMINAL
  213.       DOWNLOAD", "set session passall", and    "SET TERMINAL NO ESC",
  214.       but there is no standard set of commands suitable for    all
  215.       terminal servers.  Normally these commands are given before
  216.       attempting file transfers, but one user has reported that
  217.       the command must be given _a_f_t_e_r the file transfer is
  218.       started(!).  Until terminal server vendors improve the
  219.       quality of their product, you    may have to get    on their case
  220.       until    they adequately    support    high performance file
  221.       transfers.
  222.  
  223.       Escaping control characters with ZMODEM (sz -e) may help if
  224.       the transfer gets stuck in the same place on every attempt.
  225.       Professional-YAM and ZCOMM allow selection of    which control
  226.       characters need to be    escaped.  In extreme cases 7-bit
  227.       transmission may be required (see the    Professional-YAM/ZCOMM
  228.       manual).  If you encounter problems with control characters
  229.       you should identify which control characters are causing the
  230.       problem.  Please refer to the    sz -T command in sz.doc    for
  231.       more help.
  232.  
  233.       Flow control between the server and modem is often
  234.       defective.  This rarely causes a problem in interactive
  235.       applications whose short bursts (a screenfull    at most) fit
  236.       within the available memory buffers.    Streaming protocols
  237.       such as YMODEM-g, long packet    SuperKermit, and ZMODEM    can
  238.       overload the available buffering.  Some terminal servers
  239.       support commands to enable hardware flow control such    as
  240.       "TERM    FLOWCONTROL HARDWARE IN    OUT"; this assumes the modem
  241.       attached to the server is properly configured.
  242.  
  243.       If the terminal server is too    brain damaged to support flow
  244.       control, ZMODEM lets you fake    it by setting a    window size.
  245.       Try
  246.            sz -w2048 file...
  247.       to enable software flow control.  Experiment with different
  248.       window sizes for best    results.
  249.  
  250.       Terminal servers are designed    to accept keyboard input from
  251.       human    operators.  They may lose data when a program sends
  252.       more data to the host    faster than humans type.  Some servers
  253.       allow    larger input buffers to    support    file uploads.  If you
  254.       can upload short files (less than 100    bytes) but not longer
  255.       files, try
  256.            sz -w1024 file...
  257.       with your uploading program.    (Not all programs support this
  258.  
  259.  
  260.  
  261.      Page 4                         (printed 7/17/94)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  269.  
  270.  
  271.  
  272.       option; use ZCOMM or Professional-YAM.)
  273.  
  274.       When both flow control and character transparency are
  275.       problems, use
  276.            sz -ew1024 file...
  277.       as a starting    point.
  278.  
  279.       Sometimes the    terminal server    software is defective and must
  280.       be corrected.     Please    contact    the network's vendor for
  281.       corrective procedures.  An alternative is to install direct
  282.       serial ports for users desiring to upload files.
  283.  
  284.       We have also encountered problems when networking software
  285.       fails    to pass    data after a large amount of data has been
  286.       sent to the host.  This has happened on a PPP    internet
  287.       connection which prevented uploads of    large amounts of data
  288.       via either FTP or a ZMODEM upload (via TELNET).  The PPP
  289.       connection grinds to a standstill and    not even PING works.
  290.       The same ZMODEM/TELNET combination easily uploaded ten times
  291.       as much to a nearby machine connected    by Ethernet.
  292.  
  293.  
  294.      PPPPOOOORRRRTTTT WWWWAAAATTTTCCCCHHHHEEEERRRRSSSS
  295.       Some systems enforce a timeout which disconnects a user
  296.       after    several    minutes    of keyboard inactivity.     Long, error
  297.       free ZMODEM transfers    do not generate    keyboard activity
  298.       (this    is why ZMODEM is so efficient).     Restricting the
  299.       window size with
  300.            sz -w16384 file...
  301.       option generates terminal input at regular intervals even
  302.       when no error    correction is needed.  If problems persist,
  303.       try setting a    packet length.
  304.            sz -l1024 file...
  305.       (The default ZMODEM packet length is the file    length.)
  306.  
  307.      NNNNOOOOTTTTEEEESSSS
  308.       ZMODEM's support of XOFF/XON flow control allows proper
  309.       operation in many environments that do not support XMODEM
  310.       uploads.  Unfortunately, not all Unix    versions support input
  311.       flow control.     The TTY input buffering on some systems may
  312.       not adequately buffer    long blocks or streaming input at high
  313.       speed.  You should suspect this problem when you can't send
  314.       data to the Unix system at high speeds using ZMODEM,
  315.       YMODEM-1k or XMODEM-1k, but YMODEM with 128 byte blocks
  316.       works    properly.
  317.  
  318.       The DSZ or Pro-YAM zzzzmmmmooooddddeeeemmmm llll numeric parameter    may be set to
  319.       a value between 64 and 1024 to limit the burst length
  320.       ("zmodem pl128").  Although this compromises ZMODEM's
  321.       throughput, ZMODEM's superior    reliability remains intact.
  322.  
  323.       If a program that does not properly implement    the specified
  324.  
  325.  
  326.  
  327.      Page 5                         (printed 7/17/94)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  335.  
  336.  
  337.  
  338.       file transfer    protocol causes    _r_z to "hang" the port after a
  339.       failed transfer, either wait for _r_z to time out or keyboard
  340.       a dozen Ctrl-X characters.  Every reported instance of this
  341.       problem has been corrected by    using ZCOMM, Pro-YAM, DSZ, or
  342.       other    program    with a correct implementation of the specified
  343.       protocol.
  344.  
  345.       Many programs    claiming to support YMODEM only    support    XMODEM
  346.       with 1k blocks, and they often don't get that    quite right.
  347.  
  348.       In the case of a few poorly designed microcomputers, sending
  349.       serial data to a tty port at sustained high speeds has been
  350.       known    to cause lockups, system halts,    kernel panics, and
  351.       occasional antisocial    behaviour.  This problem is not    unique
  352.       to _r_z; newer versions    of Kermit, CRT terminals with screen
  353.       transmission,    and line noise have the    same effect.  When
  354.       experimenting    with high speed    input to a system, consider
  355.       rebooting the    system if the file transfers are not
  356.       successful, especially if the    personality of the system
  357.       appears altered.
  358.  
  359.       The Unix "ulimit" parameter must be set high enough to
  360.       permit large file transfers to Unix.
  361.  
  362.       Telebit modems must not be set to "spoof" UUCP, XMODEM,
  363.       YMODEM, or KERMIT.  Setting one of these spoofing modes
  364.       interferes with other    protocols.  Telebit's YMODEM spoofing
  365.       interferes with YMODEM transfers.
  366.  
  367.       32 bit CRC code courtesy Gary    S. Brown.  Directory creation
  368.       code from John Gilmore's PD TAR program.
  369.  
  370.      NNNNEEEETTTTWWWWOOOORRRRKKKK NNNNOOOOTTTTEEEESSSS
  371.       Escaping all control characters (sz -e) may help if the
  372.       transfer gets    stuck in the same place    on every attempt.
  373.       Professional-YAM and ZCOMM allow selection of    which control
  374.       characters need to be    escaped.
  375.  
  376.       In extreme cases 7-bit transmission may be required (see
  377.       Professional-YAM/ZCOMM manual).  7-bit transmission requires
  378.       rz version 4.50 or higher.
  379.  
  380.       Please refer to the sz -T command in sz.doc for more help.
  381.  
  382.      BBBBUUUUGGGGSSSS
  383.       This version of _r_z does not support some ZMODEM features.
  384.       Unix flavors of Professional-YAM may be linked to "rz" to
  385.       support these    features.
  386.  
  387.       The ASCII option's CR/LF to NL translation merely deletes
  388.       CR's;    undos(omen) performs a more intelligent    translation.
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                         (printed 7/17/94)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      RRRRZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         RRRRZZZZ((((1111))))
  401.  
  402.  
  403.  
  404.      ZZZZMMMMOOOODDDDEEEEMMMM CCCCAAAAPPPPAAAABBBBIIIILLLLIIIITTTTIIIIEEEESSSS
  405.       _R_z supports ZMODEM command execution (zcommand), incoming
  406.       ZMODEM binary    (-b), ASCII (-a), escape controls (-e),
  407.       newer(-n), newer+longer(-N), protect (-p), Crash Recovery(-
  408.       r), clobber (-y), match+clobber (-Y),    compression(-Z), and
  409.       append (-+) requests.     Other options sent by the sender are
  410.       ignored.  The    default    is protect (-p)    and binary (-b).
  411.  
  412.       Unix Professional-YAM    provides higher    performance and    other
  413.       features not supported by _r_z.    Please contact Omen Technology
  414.       Inc for product information.
  415.  
  416.       Omen Technology INC
  417.       503-621-3406
  418.       Post Office Box 4681
  419.       Portland OR 97208
  420.  
  421.  
  422.      FFFFIIIILLLLEEEESSSS
  423.       rz.c,    crctab.c, rbsb.c, zm.c,    zmr.c, zmodem.h, rz.1
  424.  
  425.       /tmp/rzlog stores debugging output generated with -vv    option
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.      Page 7                         (printed 7/17/94)
  460.  
  461.  
  462.  
  463.